home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / tools / 21help.com / 21HELP.DOC < prev   
Encoding:
Text File  |  1988-11-19  |  5.8 KB  |  120 lines
  1.                                   21HELP.COM 
  2.                              Bob Kaye, 73047,2422 
  3.  
  4. ARC file contains:  21H_HELP.COM - resident engine 
  5.                     21H0.TXT     - menu and text file 
  6.                     21H1.TXT     - text file 
  7.                     21H2.TXT     - text file 
  8.                     21HELP.DOC   - this file 
  9.  
  10.                                  DESCRIPTION 
  11.  
  12. 21HELP is sort of a poor man's Norton Guide describing each INT 21H function, 
  13. the other DOS interrupts and the ROM BIOS interrupts.  There is a small 
  14. resident portion (2.2K), activated by <ALT><SPACE>, which reads the three text 
  15. files from disk and displays the selected information.  It is menu driven and 
  16. for each interrupt displays a description, the required register values to 
  17. call the function and the meaning of any register values returned by the 
  18. function or interrupt.  There is also some cross referencing of functions. 
  19.  
  20. The resident portion is kept small by using high video RAM for display 
  21. purposes; this does away with the need to copy the display of any underlying 
  22. program.  An EGA card is required - though it should function with VGA also.  
  23. 21HELP will adjust the display to any EGA text mode, but will not pop up 
  24. unless the display is set for 25 lines (generally, the default). 
  25.  
  26.  
  27.                                  INSTALLATION 
  28.  
  29. The resident portion of 21H_HELP has to know where the three text files are; 
  30. it will not search for them.  There are two ways to provide this information: 
  31. when installing 21H_HELP, include the path on the command line or, using the 
  32. patch function, write the path to a copy of 21H_HELP on disk.  After patching, 
  33. there is no longer a need to indicate the path on the command line. 
  34.  
  35. Examples: 
  36.     Not Patched - 21H_HELP [DRIVE] \PATH <CR> 
  37.                   21H_HELP C:\MISC <CR> 
  38.                   21H_HELP \TEXT\21H <CR> 
  39.  
  40.     Patched     - 21H_HELP <CR> 
  41.  
  42. In addition to the path, there are two command line parameters recognized by 
  43. 21H_HELP - a patching parameter (-p or -P) and a parameter to un-install (-u 
  44. or -U).  The hyphen ( - ) before the parameter is required.  
  45.  
  46. When patching, a path must be included on the command line or an error message 
  47. will be displayed.  A copy of 21H_HELP.COM must be in the current directory. 
  48.  
  49. If 21H_HELP is the last TSR installed, the U parameter will un-install it and 
  50. free its allocated memory.  If another resident program has been installed 
  51. after it, un-installation is not possible and an appropriate message will be 
  52. displayed. 
  53.  
  54. Examples: 
  55.                21H_HELP -u <CR> 
  56.                21H_HELP -U <CR> 
  57.                21H_HELP -p \MISC <CR> 
  58.                21H_HELP -P C:\MISC\TXT <CR> 
  59.  
  60.                                       USE 
  61.  
  62. Hitting <ALT><SPACE> at any time will cause 21H_HELP to pop up.  The first 
  63. time its popped up, the main menu will be displayed with instructions at the 
  64. bottom of the screen.  Thereafter, popping it up will display the last screen 
  65. displayed before exiting.  
  66.  
  67. In most cases, the screen being displayed has instructions at the bottom.  For 
  68. those that don't, hitting <ESC> at any time will exit 21H_HELP returning you 
  69. to the underlying program.  Hitting <F1> will back up one screen or menu.    
  70.  
  71.                                     CAVEATS 
  72.  
  73. I haven't run into any compatibility problems, though my library of commercial 
  74. programs is limited.  It seems to be compatible with all the TSRs I use, 
  75. though none of these are commercial, either.  Since it does use VRAM pages 
  76. four and five, there is a potential problem with other programs that also use 
  77. this part of VRAM.  A problem caused by this will result in a lost display in 
  78. the underlying program, but should not cause a crash.  An orderly exit from 
  79. that program back to DOS should be possible. 
  80.  
  81. DOS Critical Errors from within 21H_HELP are handled politely and should not 
  82. cause a crash or a hasty exit to the DOS prompt.  A 'can't miss' error message 
  83. will be displayed and hitting any key will return you to the underlying 
  84. program.  A Critical Error will be caused by 21H_HELP being unable to find the 
  85. text files where they're supposed to be or, if they're on a floppy, by the 
  86. door being open.  
  87.  
  88. The indexing function of the resident code is keyed to the format of the three 
  89. text files as they were created.  If the files get corrupted - or edited - the 
  90. chances are the display will not line up properly.  They can be edited with a 
  91. word processor in the overwrite mode only, providing nothing is done to change 
  92. the size of the file.  A blank line in the display does not mean 80 characters 
  93. can be inserted.  The ASM file has some explanations regarding the indexing 
  94. scheme used by the menus to access specific data.  If you feel the need to 
  95. change the text files, a file editor, rather than a word processor, is more 
  96. likely to maintain the integrity of the files. 
  97.  
  98. Every effort was made to insure that the information displayed is correct.  
  99. Proofreading is not one of my strong points, so undoubtedly there are some 
  100. errors.  If you find any serious contextual errors, please let me know so that 
  101. I can correct them and re-upload the text file.  (Spelling errors I can live 
  102. with.) 
  103.  
  104. The reserved (undocumented) functions described are those that I have picked 
  105. up from what various sources.  I've used a number of them and they seem to 
  106. work - its your decision as to whether or not to use them in your own 
  107. programs.  
  108.  
  109. Obviously, I'd like to know if there are any bugs...I've been using it for 
  110. several months with none arising.  I'd also like any suggestions (I can think 
  111. of a few regarding the user interface.), criticisms and comments regarding its 
  112. utility. 
  113.  
  114.                                     CREDITS
  115.  
  116. Drew very heavily on Ray Duncan's Advanced MSDOS, Microsoft Press, 1986 for 
  117. a lot of the information. 
  118.  
  119.  
  120.